/**
 * (C) Copyright IBM Corp. 2021.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

import Foundation

/**
 DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer.

 Enums with an associated value of DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer:
    DialogNodeOutputGeneric
 */
public struct DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer: Codable, Equatable {

    /**
     The type of response returned by the dialog node. The specified response type must be supported by the client
     application or channel.
     */
    public var responseType: String

    /**
     The message to display to the user when initiating a channel transfer.
     */
    public var messageToUser: String

    /**
     Information used by an integration to transfer the conversation to a different channel.
     */
    public var transferInfo: ChannelTransferInfo

    /**
     An array of objects specifying channels for which the response is intended.
     */
    public var channels: [ResponseGenericChannel]?

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case responseType = "response_type"
        case messageToUser = "message_to_user"
        case transferInfo = "transfer_info"
        case channels = "channels"
    }

    /**
      Initialize a `DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer` with member variables.

      - parameter responseType: The type of response returned by the dialog node. The specified response type must be
        supported by the client application or channel.
      - parameter messageToUser: The message to display to the user when initiating a channel transfer.
      - parameter transferInfo: Information used by an integration to transfer the conversation to a different
        channel.
      - parameter channels: An array of objects specifying channels for which the response is intended.

      - returns: An initialized `DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer`.
     */
    public init(
        responseType: String,
        messageToUser: String,
        transferInfo: ChannelTransferInfo,
        channels: [ResponseGenericChannel]? = nil
    )
    {
        self.responseType = responseType
        self.messageToUser = messageToUser
        self.transferInfo = transferInfo
        self.channels = channels
    }

}
